Skip to main content

Workflow Form Integration

Bookadoc integrates with AthenaHealth to streamline patient intake and pre-consultation processes. After a patient books an appointment, they are required to complete a series of structured forms, which is grouped into four major categories:

The booking workflow consists of the following steps:

  1. Medical Info
  2. Other Screening(Questionnaires)
  3. Consent Forms
  4. Store appointment details in Bookadoc
  5. Reason for Visit

Each section contains specific forms, with some supporting file uploads in various formats.

1: Medical Info​

This category contains essential background and insurance data for the patient.

1.1 Basic Information Form​

Captures core patient data including emergency contact and responsible party.

API Endpoint​

PUT /v1/{practiceid}/patients/{patientid}

Request Payload Example​

{
    "first_name": "Jane",
    "last_name": "Doe",
    "middle_name": "A.",
    "dob": "1990-01-01",
    "gender": "female",
    "phone": "1234567890",
    "email": "jane.doe@example.com",
    "state": "California",
    "city": "Los Angeles",
    "zipcode": "90001",
}

Response Example​

{
    "status: "success",
    "patientid": "1224"
}

1.2 Insurance and Government ID​

This form allows patients to provide their insurance information and a valid government-issued ID using one of the following options:

  • Insurance Information: Patients can upload the front and back of their insurance card in supported formats: pdf, jpeg, or png.

    API Endpoint​

    POST /v1/{practiceid}/patients/{patientid}/documents/{filetype}

    Example Request​

    POST /v1/12345/patients/1861676/documents/insurancedocument

  • Government ID Upload:

    • Patients must upload a government-issued ID document, such as a driver’s license or national ID.

    • Only image file formats (jpeg, jpg, png) are accepted — PDFs are not allowed for government ID uploads.

      API Endpoint​

      POST /v1/{practiceid}/patients/{patientid}/driverslicense

1.3 Medical History​

Patients select known medical conditions using checkboxes.

API Endpoint​

PUT /v1/{practiceid}/appointments/{appointmentId}/healthhistoryforms/{formId}

Request Payload Example​

[
    {
        "portalformsectionid":9277,
        "questions":[
            {
                "portalformquestionid":"39039",
                "fields":{"default":"Y"}
            },
            {
                "portalformquestionid":"39043",
                "fields":{"default":"Y"}
            }
        ],
        "complete":true
    }
]

Response Example​

{
    "success": true,
}

1.4 Social History​

This form captures patient's lifestyle habits (smoking, alcohol, drug use, exercise)

API Endpoint​

PUT /v1/{practiceid}/appointments/{appointmentId}/healthhistoryforms/{formId}

Request Payload Example​

[
    {
        "type":"SOCIAL",
        "portalformsectionid":9003,
        "questions":
        [
            {
                "portalformquestionid":"1635",
                "clinicalelementid":"SOCIALHISTORY.BULLYBULLYING",
                "fields":{"default":"Y"}
            },
            {
                "portalformquestionid":"1634",
                "clinicalelementid":"SOCIALHISTORY.SOCIALMEDIA",
                "fields":{"default":"Y"}
            },
        ],
        "complete":true
    }
]

Response Example​

{
    "success": true,
}

1.4 Family History​

This form captures patient's illnesses in family members dynamically

API Endpoint​

PUT /v1/{practiceid}/appointments/{appointmentId}/healthhistoryforms/{formId}

Request Payload Example​

[
    {
        "type":"FAMILY",
        "portalformsectionid":9214,
        "name":"Family History",
        "questions":[
            {
                "text":"Bloodpressure",
                "fields":[
                    {
                        "default":"Y",
                        "relation":"Paternal Grandfather",
                        "relationkeyid":1
                    }   ,
                    {
                        "default":"Y",
                        "relation":"Maternal Grandfather",
                        "relationkeyid":1,
                        "onsetage":30,
                        "diedofage":100
                    }
                ],
                "snomedfamilyhistoryproblemid":"151",
                "portalformquestionid":"46905"
            },
            {
                "text":"Diabetes",
                "fields":[
                    {
                        "default":"Y",
                        "relation":"Paternal Grandfather",
                        "relationkeyid":1,
                        "onsetage":7,
                        "diedofage":86
                    }
                ],
                "snomedfamilyhistoryproblemid":"20",
                "portalformquestionid":"44402"
            }
        ],
        "complete":true 
    }
]

Response Example​

{
    "success": true,
}

1.5 Surgical History​

This form captures list of surgeries

API Endpoint​

PUT /v1/{practiceid}/appointments/{appointmentId}/healthhistoryforms/{formId}

Request Payload Example​

[
    {
        "type":"SURGICAL",
        "portalformsectionid":7320,
        "questions":[
            {
                "portalformquestionid":"3087",
                "surgicalhistoryprocedureid":"5",
                "fields":{"default":"Y"}
            },
            {
                "portalformquestionid":"3088",
                "surgicalhistoryprocedureid":"17",
                "fields":{"default":"Y"}
            }
        ],
        "complete":true
    }
]

Response Example​

{
    "success": true,
}

2: Other Screening (Questionnaires)​

This section consists of standardized clinical questionnaires designed to assess the patient’s mental health and lifestyle-related risk factors. Each form captures patient responses based on a scoring system and helps healthcare providers screen for conditions like depression, anxiety, and alcohol misuse.

2.1 PHQ-9 (Patient Health Questionnaire-9)​

Screens for symptoms of depression by asking patients how often they've experienced specific issues (e.g., lack of interest, fatigue, sleep problems) over the past two weeks.

2.2 GAD-7 (Generalized Anxiety Disorder-7)​

Measures the severity of anxiety by asking how often patients have been bothered by problems such as nervousness, inability to relax, and irritability over the past two weeks.

2.3 AUDIT-C (Alcohol Use Disorders Identification Test - Consumption)​

Evaluates patterns of alcohol consumption to help identify risky drinking behavior or potential alcohol use disorders.

Steps involved to submit screening questionnaires for patient​

Step 1:​

Activate the questionnaire in the patient encounter

API Endpoint​

POST /v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners

Request Payload Example​

{
    "templateid": "1",
}

Response Example​

{
    "status: "success",
    "patientid": "1224"
}

Step 2:​

Upload a PDF of the questions and answers for each screening questionnaire administered to the patient.

API Endpoint​

PUT /v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners

Request Payload Example​

{
    "entitytype": "PATIENT",
    "departmentid": "1232",
    "internalnote": "testing",
    "appointmentid": "40231",
    "attachmenttype": "pdf",
    "documentsubclass": "health history",
    "attachmentcontents": "fileStream..."
}

Response Example​

{
    "status: "success",
    "patientid": "1224"
}

Step 3:​

Get the encounter questionnaire IDs to enable uploading the screener’s answers, scores, clinical guidance

API Endpoint​

GET /v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners

Response Example​

{
    "status: "success",
    "patientid": "1224"
}

Step 4:​

Submit the screener questionnaire data for the encounter.

API Endpoint​

PUT /v1/{practiceid}/chart/encounter/{encounterid}/questionnairescreeners

Request Payload Example​

{
    "score": "8",
    "documentids": [1,2],
    "questionnaireid": "8",
    "questions": [{"questionid":"442","answer":"Female"},{"questionid":"444","answer":"No"}] ,
}

Response Example​

{
    "status: "success",
    "patientid": "1224"
}

This section contains important legal and policy documents that patients must review and acknowledge before proceeding with care. Each form outlines clinic policies or authorization agreements to ensure transparency, compliance, and patient consent.

3.1 Office Policies​

Informs patients about the clinic’s key policies, such as:

  • Financial Responsibility Agreement: Acknowledges that the patient is responsible for all service charges not covered by insurance.
  • Appointment Cancellation Policy: Explains charges or penalties for missed or late cancellations.
  • HIPAA Compliance Policy: Outlines how the clinic protects the patient’s health information in accordance with HIPAA regulations.

Grants permission for the clinic to use DeepScribe Inc. to record and transcribe conversations during consultations. This helps automate medical documentation while maintaining confidentiality.

3.3 Credit Card on File Policy​

Authorizes the clinic to securely store the patient’s credit card information and charge it for future co-pays, balances, or missed appointments, in accordance with the stated financial policies.

API Endpoint​

POST /v1/{practiceid}/patients/{patientid}/documents/{filetype}

Request Payload Example​

{
    "entitytype": "PATIENT",
    "patientid": "12345",
    "departmentid": "123",
    "attachmenttype": "pdf",
    "autoclose": "false",
    "internalnote": "sample note",
    "originalfilename": "office policy",
    "documentsubclass": "ADMIN",
    "attachmentcontents": "fileStream..."
}

Response Example​

{
    "status: "success",
    "patientid": "1224"
}

4: Reason for Visit​

This section allows patients to describe their symptoms through a conversational bot interface. Patients respond to guided prompts in free text, providing context around their condition. This helps clinicians quickly understand the patient’s concerns ahead of the appointment.

API Endpoint​

PUT /v1/{practiceid}/appointments/{appointment_id}/notes

Request Payload Example​

{
    "notetext": "I have a fever...",
    "departmentid": "123",
}

Response Example​

{
    "status: "success",
    "patientid": "1224"
}